<html><head><title>api.DomElement</title><link rel="stylesheet" type="text/css" href="../../styles/main.css"><link rel="stylesheet" type="text/css" href="../../styles/prettify.css"><script language=JavaScript src="../../javascript/prettify.js"></script><script language=JavaScript src="../../javascript/main.js"></script></head><body class="FramedContentPage" onLoad="{NDOnLoad();prettyPrint();}"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>

<!--  Generated by Natural Docs, version 1.4 -->
<!--  http://www.naturaldocs.org  -->

<!-- saved from url=(0026)http://www.naturaldocs.org -->




<div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="api.DomElement"></a>api.<wbr>DomElement</h1><div class=CBody><p>This class is a wrapper object used within &lt;api.engine.BruteForce&gt; with target &ldquo;document.body&rdquo;.</p><p>Main purpose of the wrapper is to provide the essential functions needed for all VEs</p><ul><li>requestEngineTick</li><li>getMeasuredWidth</li><li>getMeasuredHeight</li><li>getFactory</li><li>getDomElement</li></ul><h4 class=CHeading>usage</h4><blockquote><pre class="prettyprint">var domEventManager = new api.system.DomEventManager();
var engine = new api.engine.BruteForce();

var myCustomContainer = new api.DomElement(document.getElementById('customId'), engine);
var myVE = new components.Template('div', domEventManager);
myCustomContainer.addChild(myVE);

engine.start();</pre></blockquote><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#api.DomElement" >api.<wbr>DomElement</a></td><td class=SDescription>This class is a wrapper object used within &lt;api.engine.BruteForce&gt; with target &ldquo;document.body&rdquo;.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#api.DomElement.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#api.DomElement.DomElement" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">DomElement</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#api.DomElement.getEngine" >getEngine</a></td><td class=SDescription>returns the instance of the current engine used in flashjs. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#api.DomElement.getDomElementTarget" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">getDomElementTarget</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#api.DomElement.getMeasuredWidth" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">getMeasuredWidth</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#api.DomElement.getMeasuredHeight" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">getMeasuredHeight</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#api.DomElement.getFactory" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">getFactory</a></td><td class=SDescription>returns self as the current domElement has no flashjs factory need, it was created outside of flashjs</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#api.DomElement.getDomElement" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">getDomElement</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#api.DomElement.addChild" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">addChild</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#api.DomElement.removeChild" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">removeChild</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#api.DomElement.getChildIndex" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">getChildIndex</a></td><td class=SDescription></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="api.DomElement.Functions"></a>Functions</h3></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="api.DomElement.DomElement"></a>DomElement</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>DomElement : function(</td><td class=PParameter nowrap>target,</td></tr><tr><td></td><td class=PParameter nowrap>engine</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>params</h4><ul><li>target is the domElement real object taken from document DOM tree</li></ul></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="api.DomElement.getEngine"></a>getEngine</h3><div class=CBody><p>returns the instance of the current engine used in flashjs. by default it should be &lt;api.engine.BruteForce&gt;</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="api.DomElement.getDomElementTarget"></a>getDomElementTarget</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getDomElementTarget : function()</td></tr></table></blockquote></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="api.DomElement.getMeasuredWidth"></a>getMeasuredWidth</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getMeasuredWidth : function()</td></tr></table></blockquote></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="api.DomElement.getMeasuredHeight"></a>getMeasuredHeight</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getMeasuredHeight : function()</td></tr></table></blockquote></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="api.DomElement.getFactory"></a>getFactory</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getFactory : function()</td></tr></table></blockquote><p>returns self as the current domElement has no flashjs factory need, it was created outside of flashjs</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="api.DomElement.getDomElement"></a>getDomElement</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getDomElement : function()</td></tr></table></blockquote></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="api.DomElement.addChild"></a>addChild</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>addChild : function(</td><td class=PParameter nowrap>child</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="api.DomElement.removeChild"></a>removeChild</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>removeChild : function(</td><td class=PParameter nowrap>child</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="api.DomElement.getChildIndex"></a>getChildIndex</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getChildIndex : function(</td><td class=PParameter nowrap>child</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div></div>

</div><!--Content-->



<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>DomElement : function(</td><td class=PParameter nowrap>target,</td></tr><tr><td></td><td class=PParameter nowrap>engine</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getDomElementTarget : function()</td></tr></table></blockquote></div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getMeasuredWidth : function()</td></tr></table></blockquote></div></div><div class=CToolTip id="tt4"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getMeasuredHeight : function()</td></tr></table></blockquote></div></div><div class=CToolTip id="tt5"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getFactory : function()</td></tr></table></blockquote>returns self as the current domElement has no flashjs factory need, it was created outside of flashjs</div></div><div class=CToolTip id="tt6"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getDomElement : function()</td></tr></table></blockquote></div></div><div class=CToolTip id="tt7"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>addChild : function(</td><td class=PParameter nowrap>child</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt8"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>removeChild : function(</td><td class=PParameter nowrap>child</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt9"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getChildIndex : function(</td><td class=PParameter nowrap>child</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><!--END_ND_TOOLTIPS-->

<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>